---
title: "get key · RUAL Documentation"
description: "Get given key from the current UI state."
canonical: https://docs.rual.nl/block-types/state ui/state_get_custom_field
language: en
---

# get key

This block is part of the [`state ui`](https://docs.rual.nl/block-types/state%20ui) group and was last modified in core [`v10.4.28`](https://docs.rual.nl/core-versions/100428).

### Type Selection Required

This block requires you to select the data type you want to work with. You must manually select the type using the type selector modal. To access the modal, click the white button on the block.

### Field Selection Required

This block requires field selection (out). You must manually select the fields you want to work with using the field selector modal. To access the modal, click the white button on the block.

Get given key from the current UI state.

- field required `value` The name of field to grab from the current UI state. Can be deep-key (e.g. `form.name`)

| `custom field` |
| --- |

A typical wiring for [get key](https://docs.rual.nl/block-types/state%20ui/state_get_custom_field): [value](https://docs.rual.nl/block-types/value/value_default) feeds the `field` pin.

![Studio canvas example for the get key block: typical wiring for get key.](https://docs.rual.nl/canvas-examples/state_get_custom_field.png)

### Commonly used with

In production blueprints, this block is most often wired together with:

- [value](https://docs.rual.nl/block-types/value/value_default): feeds into this block. Simply returns the provided value.

- [is not empty](https://docs.rual.nl/block-types/condition/condition_not_empty_value): this block feeds into it. checks if the value is filled (not empty).

- [if](https://docs.rual.nl/block-types/state%20ui/state_branch): this block feeds into it. Allows you to use different state UIs based on your given condition.

- [custom text](https://docs.rual.nl/block-types/state%20ui/state_text): this block feeds into it.

### Version history

Introduced in [`v10.4.28`](https://docs.rual.nl/core-versions/100428).